/** 
 *  Copyright (c) 2013  Ng Pan Wei
 *  
 *  Permission is hereby granted, free of charge, to any person 
 *  obtaining a copy of this software and associated documentation files 
 *  (the "Software"), to deal in the Software without restriction, 
 *  including without limitation the rights to use, copy, modify, merge, 
 *  publish, distribute, sublicense, and/or sell copies of the Software, 
 *  and to permit persons to whom the Software is furnished to do so, 
 *  subject to the following conditions: 
 *  
 *  The above copyright notice and this permission notice shall be 
 *  included in all copies or substantial portions of the Software. 
 *  
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 
 *  BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 
 *  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
 *  SOFTWARE. 
 */

package jFeature.reporting;

import jFeature.analysis.Analysis;
import jFeature.analysis.ElementMap;
import jFeature.analysis.ElementNode;
import jFeature.analysis.TraceabilityMatrix;

public abstract class ReportVisitor {
	static final String TRACEABILITY_METRICS = "Traceability Metrics";
	static final String FEATURE_METRICS = "Feature Metrics";
	static final String CLASS_METRICS = "Class Metrics";
	public abstract String getHeader(Analysis analysis) ;
	public abstract String getFooter(Analysis analysis) ;
	public abstract String getFeatureHeader(ElementMap featureMap) ;
	public String getFeatureFooter(ElementMap featureMap) {
		return lineSeparator() ;		
	}
	public abstract String getFeatureEntry(ElementNode node) ;
	public abstract String getClassHeader(ElementMap classMap) ;
	public String getClassFooter(ElementMap classMap) {
		return lineSeparator() ;
	}
	public abstract String getClassEntry(ElementNode node) ;
	protected String lineSeparator() {
		return System.getProperty("line.separator");
	}
	public abstract String getTraceability(Analysis analysis, TraceabilityMatrix matrix) ;
	protected String getTag(int size) {
		String temp = "" ;
		if(size>0) {
			temp += " + " ;
		} else {
			temp += " ? " ;
		}
		return temp;
	}
	
}
